<?php
////////////////////////////////////////////////////////////////////////////
//                                                                        //
// NOTICE OF COPYRIGHT                                                    //
//                                                                        //
// Dean`s Office for Moodle                                               //
// Электронный деканат                                                    //
// <http://deansoffice.ru/>                                               //
//                                                                        //
// Copyright (C) 2008-2999  Alex Djachenko (Алексей Дьяченко)             //
// alex-pub@my-site.ru                                                    //
// This program is free software: you can redistribute it and/or modify   //
// it under the terms of the GNU General Public License as published by   //
// the Free Software Foundation, either version 3 of the Licensen.        //
//                                                                        //
// This program is distributed in the hope that it will be useful,        //
// but WITHOUT ANY WARRANTY; without even the implied warranty of         //
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the          //
// GNU General Public License for more details.                           //
//                                                                        //
// You should have received a copy of the GNU General Public License      //
// along with this program.  If not, see <http://www.gnu.org/licenses/>.  //
//                                                                        //
////////////////////////////////////////////////////////////////////////////

/**
 * COV - custom options values.
 * Справочник, позволяющий хранить дополнительные опции для всех справочников.
 * @author Ilya Fastenko 2014. Opentechnology Ltd.
 */
class dof_storage_comments extends dof_storage
{

    /**
     * @var object dof_control - объект с методами ядра деканата
     */
    protected $dof;

    // **********************************************
    // Методы, предусмотренные интерфейсом plugin
    // **********************************************

    /**
     * Метод, реализующий обновление плагина в системе
     * Создает или модифицирует существующие таблицы в БД
     * 
     * @param string $old_version - версия установленного в системе плагина
     * @return boolean
     * @access public
     */
    public function upgrade($oldversion)
    {
        return true; // уже установлена самая свежая версия
    }

    /**
     * Возвращает версию установленного плагина
     * 
     * @return string
     * @access public
     */
    public function version()
    {
        // Версия плагина (используется при определении обновления)
        return 2014101515;
    }

    /**
     * Возвращает версии интерфейса Деканата,
     * с которыми этот плагин может работать
     * 
     * @return string
     * @access public
     */
    public function compat_dof()
    {
        return 'aquarium';
    }

    /**
     * Возвращает версии стандарта плагина этого типа,
     * которым этот плагин соответствует
     * 
     * @return string
     * @access public
     */
    public function compat()
    {
        return 'paradusefish';
    }

    /**
     * Возвращает тип плагина
     * 
     * @return string
     * @access public
     */
    public function type()
    {
        return 'storage';
    }

    /**
     * Возвращает короткое имя плагина
     * Оно должно быть уникально среди плагинов этого типа
     * 
     * @return string
     * @access public
     */
    public function code()
    {
        return 'comments';
    }

    /**
     * Возвращает список плагинов,
     * без которых этот плагин работать не может
     * 
     * @return array
     * @access public
     */
    public function need_plugins()
    {
        return array();
    }

    /**
     * Список обрабатываемых плагином событий
     * 
     * @return array - array(array('plugintype'=>..,'plugincode'=>..,'eventcode'=>..),...)
     * @access public
     */
    public function list_catch_events()
    {
        // Пока событий не обрабатываем
        return array();
    }

    /**
     *  Требуется ли запуск cron в плагине
     * 
     * @return bool
     * @access public
     */
    public function is_cron()
    {
        return false;
    }

    /**
     * Проверяет полномочия на совершение действий
     * 
     * @param string $do - идентификатор действия, которое должно быть совершено
     * @param int $objid - идентификатор экземпляра объекта,
     * по отношению к которому это действие должно быть применено
     * @param int $userid - идентификатор пользователя, полномочия которого проверяются
     * @return bool true - можно выполнить указанное действие по отношению к выбранному объекту
     * false - доступ запрещен
     * @access public
     */
    public function is_access($do, $objid = NULL, $userid = NULL)
    {
        // Используем функционал из $DOFFICE
        return $this->dof->is_access($do, NULL, $userid);
    }

    /**
     * Обработать событие
     * 
     * @param string $gentype - тип модуля, сгенерировавшего событие
     * @param string $gencode - код модуля, сгенерировавшего событие
     * @param string $eventcode - код задания
     * @param int $intvar - дополнительный параметр
     * @param mixed $mixedvar - дополнительные параметры
     * @return bool - true в случае выполнения без ошибок
     * @access public
     */
    public function catch_event($gentype, $gencode, $eventcode, $intvar, $mixedvar)
    {
        // Ничего не делаем, но отчитаемся об "успехе"
        return true;
    }

    /**
     * Запустить обработку периодических процессов
     * 
     * @param int $loan - нагрузка (1 - только срочные, 2 - нормальный режим, 3 - ресурсоемкие операции)
     * @param int $messages - количество отображаемых сообщений (0 - не выводить,1 - статистика,
     *  2 - индикатор, 3 - детальная диагностика)
     * @return bool - true в случае выполнения без ошибок
     * @access public
     */
    public function cron($loan, $messages)
    {
        return true;
    }

    /**
     * Обработать задание, отложенное ранее в связи с его длительностью
     * 
     * @param string $code - код задания
     * @param int $intvar - дополнительный параметр
     * @param mixed $mixedvar - дополнительные параметры
     * @return bool - true в случае выполнения без ошибок
     * @access public
     */
    public function todo($code, $intvar, $mixedvar)
    {
        return true;
    }

    /**
     * Конструктор
     * 
     * @param dof_control $dof - объект с методами ядра деканата
     * @access public
     */
    public function __construct($dof)
    {
        // Сохраняем ссылку на DOF, чтоб вызывать его через $this->dof
        $this->dof = $dof;
    }

    /**
     * Возвращает название таблицы без префикса (mdl_)
     * с которой работает examplest
     * 
     * @return text
     * @access public
     */
    public function tablename()
    {
        // Имя таблицы, с которой работаем
        return 'block_dof_s_comments';
    }
    // **********************************************
    //              Собственные методы
    // **********************************************

    /** 
     * Сохраняет комментарий в базу данных.
     * Принимает имя отправителя, 
     * 
     * @param string $name - имя отправителя
     * @param string $message - текст комментария,
     * @param int $time - время отправления,
     * @param int $message_id - id сообщения, под которым оставлен комментарий.
     * Возвращает результат.
     * @return bool|mysqli_result
     */
    function set_comment($name, $message, $time, $message_id)
    {
        $result;

        if ( empty($time) )
        {
            $time = time();
        }

        $record            = new stdClass();
        $record->name      = $name;
        $record->comment   = $message;
        $record->time      = $time;
        $record->messageid = $message_id;


        if ( empty($message_id) )
        {
            $result = false;
        } else
        {
            $result = $this->dof->storage($this->code())->insert($record);
        }
        return $result;
    }

    /** 
     * Возвращает комментарии из базы данных.
     * 
     * @param int $message_id - id сообщения, под которым оставлены комментарии. 
     * @return array
     */
    function get_comments($message_id)
    {

        $result = $this->dof->storage($this->code())->get_records(array('messageid' => $message_id));

        $data = array();

        foreach ( $result as $element )
        {
            array_push($data, $element);
        }

        return $data;
    }

    /** 
     * Удаляет комментарий из базы данных.
     * Принимает id удаляемого комментария.
     * 
     * @param int $id - возвращает результат удаления.
     * @return bool|mixed|mysqli_result
     */
    function delete_comment($id)
    {

        $result = $this->dof->storage($this->code())->delete($id);

        return $result;
    }
}
?>